Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC-677 Add docs for license status in redpanda resource #879

Open
wants to merge 35 commits into
base: v-WIP/24.3
Choose a base branch
from
Open

DOC-677 Add docs for license status in redpanda resource #879

wants to merge 35 commits into from

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Nov 26, 2024 •
edited
Loading

Description

Review deadline: 27 November

Page previews

https://deploy-preview-879--redpanda-docs-preview.netlify.app/24.3/get-started/licensing/monitor-license-status/#check-the-license-status-on-the-redpanda-resource-in-kubernetes

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Deflaimun and others added 26 commits November 19, 2024 12:37
@Deflaimun
Update config for new beta
7455d51
@Deflaimun @Feediver1
update with rpk 24.3.1-rc1 (#819)
b26cb0d 
Co-authored-by: Joyce Fee <[email protected]>
@JakeSCahill @Deflaimun
@pgellert @asimms41
DOC-502 License enforcement updates (#813)
4cb6671 
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
@Deflaimun @Feediver1
Properties 24 3 (#822)
bc9749e 
Co-authored-by: Joyce Fee <[email protected]>
@JakeSCahill @Deflaimun @Feediver1
Add User resource docs (#773)
3ddeef4 
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
@kbatuigas @asimms41
@Feediver1 @Deflaimun
Leader pinning (#809)
29a0352 
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
@kbatuigas @asimms41
@Feediver1 @Deflaimun
DOC-287 Mountable TS topics (#725)
5efc18c 
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
@Deflaimun
Update with latest rpk commands from v0.0.0-20241104git4a0f859 (#835)
8a97c9d
@micheleRP @kbatuigas
@JakeSCahill @Deflaimun @pgellert @asimms41
what's new in 24.3 beta (#811)
e57f5dc 
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Jake Cahill <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
@Deflaimun
Force-update fallback 24.3-rc2
6ac5cc8
@micheleRP @Deflaimun
Michele rp patch 1 (#837)
a437f34
@JakeSCahill @kbatuigas @Deflaimun
DOC-470 Debug bundle in Redpanda Console (#825)
fa14029 
Co-authored-by: Kat Batuigas <[email protected]>
@Deflaimun
add Tombstone property (#847)
0b5d3d4
@kbatuigas @Feediver1 @Deflaimun
Tombstone retention (#829)
440bdd4 
Co-authored-by: Joyce Fee <[email protected]>
@Feediver1 @micheleRP
@JakeSCahill @Deflaimun
Doc-476 - Backfill partitioning update (#842)
2e4c81c 
Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Jake Cahill <[email protected]>
@Feediver1 @JakeSCahill
@micheleRP @Deflaimun
Doc 2599 - Configure Redpanda with a Customer-Managed Key (#808)
c121ad3 
Co-authored-by: JakeSCahill <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Jake Cahill <[email protected]>
@micheleRP @Deflaimun
DOC-759 fix link (#866)
eedc7c2
@kbatuigas @Deflaimun
Change status of intra broker balancing from beta to GA (#855)
332aeed
@micheleRP @JakeSCahill
@kbatuigas @Deflaimun
DOC-758 Update What's New for 24.3 GA (#865)
fb335c4 
Co-authored-by: Jake Cahill <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
@JakeSCahill @Deflaimun
@Feediver1 @pgellert @asimms41 @kbatuigas @micheleRP
DOC-425 How to use the new debug bundle cluster configs (#862)
62205f5 
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
@JakeSCahill @Deflaimun
@Feediver1 @pgellert @asimms41 @kbatuigas @micheleRP
DOC-511 Schema CRD (#848)
9954263 
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
@JakeSCahill @Deflaimun
@Feediver1 @pgellert @asimms41 @kbatuigas @micheleRP
DOC-546 Document the new useFlux flag (#859)
4f3a993 
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
@JakeSCahill @Deflaimun
@Feediver1 @pgellert @asimms41 @kbatuigas @micheleRP
DOC-657 Add note about 30-day baked-in trial licenses for Redpanda 24…
1e54b6b 
….3 (#853)

Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
@JakeSCahill
Update generate-bundle.adoc
24c7ca9
@JakeSCahill @Deflaimun
@Feediver1 @pgellert @asimms41 @kbatuigas @micheleRP
Document support for PKCS#12 (#860)
8b65a24 
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
@JakeSCahill
Add docs for license status in RP resource
c7d9e47
@JakeSCahill JakeSCahill requested a review from a team as a code owner November 26, 2024 19:48
@netlify Netlify
Copy link

netlify bot commented Nov 26, 2024 •
edited
Loading

✅ Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit c7d9e47
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/674626152838c9000833a953
😎 Deploy Preview https://deploy-preview-879--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify Netlify
Copy link

netlify bot commented Nov 26, 2024 •
edited
Loading

👷 Deploy Preview for redpanda-docs-preview processing.

Name Link
🔨 Latest commit 1c5b0da
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/674e0cc21ebaa100080cbc4f

andrewstucki
andrewstucki reviewed Nov 26, 2024
View reviewed changes
modules/get-started/pages/licensing/monitor-license-status.adoc Outdated
Comment on lines 180 to 182
- `valid`: Indicates whether the license is valid (true) or not (false).
- `expiryDate`: The date the license will expire (format: YYYY-MM-DD).
- `features`: A list of enterprise features currently in use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just FYI, other than valid, we don't show this information in Kubernetes, and valid is just a status condition, there's no licenseStatus part of the CRD, we only publish status information under the ClusterLicenseValid condition in status.conditions.

We could add additional details if we want to, but that's not how this currently works. @david-yu thoughts about extending the status to incorporate some of these or is just publishing how to check these via execing and running rpk cluster license info enough since we publish the non-granular license status in the CRD?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrewstucki It would be nice to include those fields as well. I don't know if its possible to do another release of the Operator by Tuesday that includes those fields?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also is this status going to be updated a lot or will only happen maybe like once an hour or so?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be possible to cut something by Tuesday, but seeing as it's a long holiday weekend and the changes will need to get reviewed, it might not land.

RE the updates -- this license check would get run every reconciliation, so whenever something on the Redpanda object (including status) change, when any of its owned resources that it's set up to watch change (I know it watches the StatefulSet, and any Deployments from things like Console), or by default 10 hours defined by a cache resynchronization setting in the controller runtime.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok lets see how it goes through this week. Perhaps Rafal can help review if a PR is available by tomorrow?

andrewstucki
andrewstucki requested changes Nov 26, 2024
View reviewed changes
Copy link
Contributor

@andrewstucki andrewstucki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going to go ahead and request changes here since these fields don't exist on the CRD as of today, but also pinging David to see if he wants me to add them.

@JakeSCahill
Copy link
Contributor Author

Updated the PR to document how it currently works. I can follow up if/when we change the operator to display more data like expiry and enabled features..

@andrewstucki andrewstucki mentioned this pull request Nov 27, 2024
Open
david-yu
david-yu approved these changes Dec 2, 2024
View reviewed changes
Copy link
Contributor

@david-yu david-yu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks pretty thorough based on my review. I have not tested this out myself but it looks good for tomorrow.

@Deflaimun
Merge branch 'v-WIP/24.3' into DOC-677
1c5b0da 
# Conflicts:
#	modules/get-started/pages/licensing/monitor-license-status.adoc
#	modules/get-started/pages/whats-new.adoc
#	modules/reference/pages/properties/cluster-properties.adoc
andrewstucki
andrewstucki approved these changes Dec 2, 2024
View reviewed changes
Copy link
Contributor

@andrewstucki andrewstucki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving while following up in another PR to implement the desired extended status fields in the CRD

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrewstucki andrewstucki andrewstucki approved these changes

@david-yu david-yu david-yu approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@JakeSCahill @david-yu @andrewstucki @Deflaimun @kbatuigas @micheleRP @Feediver1